/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2011 Sun Microsystems, Inc.
 */
package org.nbphpcouncil.modules.php.ci;

import org.netbeans.modules.php.api.util.UiUtils;

/**
 *
 * @author Junji Takakura
 */
public abstract class CIPhpFramework {

    public static final String OPTIONS_SUB_PATH = "CI"; // NOI18N
    public static final String FILE_INDEX_PHP = "index.php"; // NOI18N
    public static final String FILE_CI_PHP = "CodeIgniter.php"; // NOI18N
    public static final String FILE_CONFIG_PHP = "config.php"; // NOI18N
    public static final String FILE_DOT_HTACCESS = ".htaccess"; // NOI18N
    public static final String DIRECTORY_APPLICATION = "application"; // NOI18N
    public static final String DIRECTORY_SYSTEM = "system"; // NOI18N
    public static final String DIRECTORY_CORE = "core"; // NOI18N
    public static final String DIRECTORY_CONFIG = "config"; // NOI18N
    public static final String DIRECTORY_USER_GIDE = "user_guide"; // NOI18N
    public static final String DIRECTORY_CACHE = "cache"; // NOI18N

    protected static final String PATH_SEPARATOR = "/"; // NOI18N

    public static String getSystemCorePath() {
        return DIRECTORY_SYSTEM + PATH_SEPARATOR + DIRECTORY_CORE;
    }

    public static String getSystemCoreCIFilePath() {
        return getSystemCorePath() + PATH_SEPARATOR + FILE_CI_PHP;
    }

    public static String getApplicationCacheDirectoryPath() {
        return DIRECTORY_APPLICATION + PATH_SEPARATOR + DIRECTORY_CACHE;
    }

    public static String getApplicationConfigDirectoryPath() {
        return DIRECTORY_APPLICATION + PATH_SEPARATOR + DIRECTORY_CONFIG;
    }

    public static String getApplicationConfigFilePath() {
        return getApplicationConfigDirectoryPath() + PATH_SEPARATOR + FILE_CONFIG_PHP;
    }

    public static String getOptionsPath() {
        return UiUtils.OPTIONS_PATH + PATH_SEPARATOR + getOptionsSubPath(); // NOI18N
    }

    public static String getOptionsSubPath() {
        return OPTIONS_SUB_PATH;
    }
}
